This is the total number of Scripted Functions that will be loaded for Objects to use during their "Movement Phase". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Movement. Each file is listed below:


• Movement Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Movement. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use during their "Drawing Phase". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Drawing. Each file is listed below:


• Drawer Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Drawing. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use during their Player-initiated "Collision Phase". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Collision. Each file is listed below:


• Collision Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Collision. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use in their Projectile-initiated "Collision Phase". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Projectile Collision. Each file is listed below:


• Projectile Collision Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Projectile Collision. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use for their "Animation". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Animation. Each file is listed below:


• Animation Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Animation. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use during their "Debug Placement Phase". This must reflect the total number of Functions that are loaded in the files referenced below.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object Placement. Each file is listed below:


• Debug Placement Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object Placement. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This is the total number of Scripted Functions that will be loaded for Objects to use during their "Debug Drawing Phase". This must reflect the total number of Functions that are loaded in the files referenced below. This takes place when an Object should be drawn in debug mode, or in the Object Editor.

This is the number of files that should be loaded in order to load all of the Scripted Functions that should be listed for Object "Debug" Drawing. Each file is listed below:


• Debug Drawing Func File
  
  
  This is the name of a file that contains the Functions that should be listed for Object "Debug" Drawing. If the file doesn't exist in this folder, its path must be included. The path must be "relative", meaning that it tells how to get to the file from this folder, not the "Root Directory".
  

This value represents the number of "Game Objects" that will be defined below.

If this Object Def is loaded by the "Game Def" as the game-global Object set, the very first entry in this list (Entry 0) should contain no special settings, because Object Type 0 is always regarded as invalid/"destroyed". Object Defs loaded for "Zones" or "Acts" by the "Zone Def may use entry 0 for a valid Object.


• Obj
  
  
  Each "Game Gbject" is listed directly below the number of total "Game Objects" as follows:
  
  
  • Drawing Priority
    
    
    This value is given to the Object's "Object_Priority" variable upon spawn, and determines where the Object goes in the active Object listing, essentially determining in what order they are processed and drawn to the screen. Higher values are drawn first (in the back), and lower values are drawn last (in the front).
    
    
    
  • Extra Variables
    
    
    This value specifies how many "Extra Variables" the Object will have in addition to the primary ones such as Position and Priority. Each Built-in Function requires a certain number of "Extra Variables", and that some of them be used in a certain way. This is described in more detail in the descriptions for each of those Functions.
    
    
    
  • Out of Range Event
    
    
    This value specifies what to do with an Object when it resides outside of "Activity Range", which is up to 160 pixel-units away from the current screen in any direction. The following actions are available:
    
    

    0	-	_Range_Freeze	-	The Object remains frozen in place in its current state; it is not processed in any way.
    1	-	_Range_StayActive	-	The Object remains "active"; it continues processing as if it were within "Activity Range"
    2	-	_Range_Reset	-	The Object is reverted to its "Reset State" as soon as that state and its active state are both outside of "Activity Range". Until then, it is made inaccessible and held in suspension.
    3	-	_Range_Destroy	-	The Object is destroyed
    f	-		-	"f" prefix for a value (such as "f10", "fZ1") references a Scripted Object Movement Function to run once, when the Object first falls outside of "Activity Range". Otherwise behaves like "_Range_Freeze".
    F	-		-	"F" prefix for a value (such as "F13", "FA2") references a Scripted Object Movement Function to run once, when the Object first falls outside of "Activity Range". Otherwise behaves like "_Range_StayActive"

    
    If a Function is used, it is called when a previously-active Object that now falls outside of "Activity Range" is first met during the Movement Phase. If the Function breaks and/or loops, it will be treated as a normal Scripted Movement Function, and will continue processing each time the Movement Phase occurs when the Object is again considered to be "active", until it either ends or is disabled.
    
    
    
  • Flags
    
    
    "Flags" define certain special properties of an Object type. If no Flags should be enabled, a value of "0" should be entered in this field. Otherwise, this field is filled by listing the identifier letters that correspond with the desired flags (such as "SC"). The identifiers are as follows:
    
    S - This Object can be saved into an itm file. If the "S" flag is not listed, the Object will not be saved. Any normal obstacle or item placed manually into the level should usually be saved, whereas certain special Script-spawned Objects that perform special operations should not.
    
    C - When this Object is destroyed, its Children are automatically destroyed too
    
    
    
  • Movement Function
    
    
    This is the ID value of the Built-in Movement Function that should be used during the Object's "Movement Phase".
    
    
    
  • Scrpt Movement Function
    
    
    This is the ID value of the Script Function that should be called during the Object's "Movement Phase", after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Movement Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Movement Function of the given ID)
    
    "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
    
    
    
  • Drawing Function
    
    
    This is the ID value of the Built-in Drawing Function that should be used during the Object's "Drawing Phase".
    
    
    
  • Script Drawing Function
    
    
    This is the ID value of the Script Function that should be called during the Object's "Drawing Phase", after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Drawing Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Drawing Function of the given ID)
    
    "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
    
    
    
  • Collide Function
    
    
    This is the ID value of the Built-in Collision Function that should be used during the Object's Player-initiated "Collision Phase".
    
    
    
  • Script Collide Function
    
    
    This is the ID value of the Script Function that should be called during the Object's "Collision" phase, after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Collision Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Collision Function of the given ID)
    
    "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
    
    
    
  • PCollide Function
    
    
    This is the ID value of the Built-in Projectile Collision Function that should be used during the Object's Projectile-initiated "Collision Phase".
    
    
    
  • Script PCollide Function
    
    
    This is the ID value of the Script Function that should be called during the Object's "Projectile Collision" phase, after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Projectile Collision Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Projectile Collision Function of the given ID)
    
    "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
    
    
    
  • Debug P Function
    
    
    This is the ID value of the Built-in Debug Placement Function that should be used during the Object's "Debug Placement Phase".
    
    
    
  
  
• Script Debug P Function
  
  
  This is the ID value of the Script Function that should be called during the Object's "Debug Placement" phase, after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Debug Placement Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Debug Placement Function of the given ID)
  
  "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
  
  
  
• Debug D Function
  
  
  This is the ID value of the Built-in Debug Drawing Function that should be used during the Object's "Debug Drawing Phase".
  
  
  
• Script Debug D Function
  
  
  This is the ID value of the Script Function that should be called during the Object's "Debug Drawing" phase, after the Built-in Function. The "G", "Z", and "A" flags may be used here to reference Scripted Object Debug Drawing Functions loaded as Game-global, "Zone"-specific, or "Act"-specific, respectively. Not entering a flag will cause HCGE to display a warning and use a function from the listing loaded by the current Object Def (IE: this will cause an Object within a "Zone"-specific Object def to reference the "Zone"-specific Debug Drawing Function of the given ID)
  
  "_Func_None" can be used instead of an ID value to specify that no Script Function should be used for this event
  
  
  
• Spawn Values
  
  
  These are only listed if the Number of "Extra Variables" for this Object Type is greater than "0". If there are "Extra Variables" defined for this Object Type, there is one "Spawn Value" for each of them to determine what value that variable receives when an Object of this Type is spawned. If there are 0 "Extra Variables", "Spawn Values" should be omitted.
  
  
  • Value
    
    
    If the number of "Extra Variables" is greater than 0, each of those "Extra Variables" receives one of thse "values" in the "Spawn Values" section.
    
    This value specifies what will be placed into the corresponding "Extra Variable" when this Object is spawned. It may be a constant value (a literal number, such as "5"), or it may be a reference to an entry in the "Parameters" array given during spawn.
    
    The "parameters" array allows for easily manipulating the initial values of "Extra Variables" when a single Object Type must be spawned in different ways. To use one of these "parameters", this value must be the ID number of desired "parameter", prefixed with an astersik (such as "*0" for the first "parameter" in the list).
    
    Other modifiers that can be used include the "X+", "X-", "Y+", and "Y-" modifiers. Using these will cause the value entered to become an offset from the Object's position (IE: "X+5" will give this variable the X position of the Object plus 5).
    
    Finally, the "R" and "r" tags may also be used to give the variable the value currently stored in a Register.
    
  
  
• Num Sprite Sets
  
  
  This is the number of "Sprite Sets" that should be assigned to this Object for it to use when it is being drawn, and whose Collision Boxes to use during collision. The first set listed will be default, because the Object's Object's "Object_CurrSprSet" variable is initially set to 0 upon spawn. Changing the value of "Object_CurrSprSet" to any entry ID for this list will cause that Sprite Set to be used for display.
  
  The Sprite Set IDs are listed immediately below:
  
  
  • Set ID
    
    
    This is the ID number of the "Sprite Set" that should be assigned to the Object at this position in its Sprite Set listing. When the Object's "Object_CurrSprSet" Variable references this Sprite Set, its ID number will be its position in this listing.
    
    This value can use the "G", "Z", and "A" flags to reference Sprite Sets that were included in by Object Defs that were loaded as "Game-global", "Zone"-specific, or "Act-specific", respectively.
    
    An Object may reference Sprites from a Player's "Character Def" by using the "P" flag along with the ID number of the Player Character whose Sprites should be used (such as "P0" for using the very first Player Character's Sprite Set)
    
  
  
• Num Animations
  
  
  This is the number of Scripted Animation Functions that should be assigned to this Object for it to use during its "Animation" process, if it is started.
  
  The Animation IDs are listed immediately below:
  
  
  • Animation ID
    
    
    This is the ID number of the Animation Function that should be assigned to the Object at this position in its listing. When the Object references this Animation, its ID number will be its position in this listing.
    
    This value can use the "G", "Z", and "A" flags to reference Animations that were included in by Object Defs that were loaded as "Game-global", "Zone"-specific, or "Act-specific", respectively.
    
  
  
• Num Sounds
  
  
  This is the number of sound effects that should be assigned to this Object for it to use at any point when it needs to play an Object-specific sound.
  
  Sound Effects can be played from their standard listing; this list only serves to group Sound Effects within an Object type for cases such as several Object Types running a Function that plays Sound Effect 0 from within this list, which would cause a different sound to play for each of the different Types
  
  The Sound Effect IDs are listed immediately below:
  
  
  • Sound ID
    
    
    This is the ID number of the sound effect that should be assigned to the Object at this position in its listing. When the Object references this sound, its ID number will be its position in this listing.
    
    This value can use the "G", "Z", and "A" flags to reference sound effects loaded as "Game-global", "Zone"-specific, or "Act-specific", respectively.
    

This is the number of Object types to link to this Object type, for use if this Object must spawn another Object specific to this list during gameplay.

Objects can be spawned by their standard ID; this list only serves to group Object Types within another Object Type for cases such as several Object Types running a Function that spawns Object Type 0 from within this list, which would cause a different Object to be spawned for each of the different Types

The Object Type IDs are listed immediately below:


• Object ID
  
  
  This is the ID number of the Object Type that should be assigned to the Object at this position in its listing. When the Object spawns an Object of this type, the type passed will be its position in this listing. This value can use the "G", "Z", and "A" flags to reference data loaded by other parts of the game.
  

This is the number of "Constant" listings that should be set up for this Object. A "Constant" is a value that stays the same for every Object of this type, however, it is changeable in the Script to customize certain aspects of the Object.

Each Listing set is listed immediately below in the following manner:


• Num Constants
  
  
  This is the number of "Constants" that will appear in this list. Each constant is listed directly below:
  
  
  • Constant
    
    
    This is the value that is to be placed into the Constant List at this position.
    

The following is an example setup for an Object Def file to better demonstrate how to put the above information into practice. Use the same format and fill in the appropriate values given the information contained throughout the various documents to create a set of "Game Objects" for an HCGE game.

;;;;;;;;;;;;;;;;;;;;;;
; Example Object Def ;
;;;;;;;;;;;;;;;;;;;;;;

Sprite File:  art/global.spr

Number of total Movement Funcs:    3
Number of Movement Func Files:     1
          Movement Func File 0:   objmv.def
                                 ;0-  Scripted Movement Function 0
                                 ;1-  Scripted Movement Function 1
                                 ;2-  Scripted Movement Function 2

Number of total Projectile Collision Funcs:   0
Number of Projectile Collision Func Files:    0


Number of total Animation Funcs:    2
Number of Animation Func Files:     1
          Animation Func File 0:    objani.def
                                   ;0- Scripted Animation Function 0
                                   ;1- Scripted Animation Function 1

Number of total Debug Placement Funcs:   1
Number of Debug Placement Func Files:    1
          Debug Placement Func File 0:   objdp.def
                                        ;0- Scripted Debug Placement Function 0

Number of total Debug Drawing Funcs:   1
Number of Debug Drawing Func Files:    1
          Debug Drawing Func File 0:   objdd.def
                                      ;0- Scripted Debug Drawing Function 0


Number of Objects:  5

;;;;;;;;;;;
;If this Object Def were loaded as "Game-global" by a "Game Def", Entry 0 should be regarded as "invalid", and have no useful settings
;If this Object Def were loaded as "Zone-specific" by a "Zone Def", Entry 0 may contain a valid, useable Object Type entry
;;;;;;;;;;;

Obj  0- Blank Object
        Drawing Priority:     0
         Extra Variables:     0
      Out Of Range Event: _Range_Freeze
                   Flags:     0
       Movement Function: _OMove_None
 Scrpt Movement Function: _Func_None
        Drawing Function: _ODraw_None
 Script Drawing Function: _Func_None
        Collide Function: _OCol_None
 Script Collide Function: _Func_None
       PCollide Function: _OPCol_None
 Scrpt PCollide Function: _Func_None
        Debug P Function: _ODebugP_None
 Script Debug P Function: _Func_None
        Debug D Function: _ODebugD_None
 Script Debug D Function: _Func_None
 Spawn Values-      None
         Num Sprite Sets:     0
          Num Animations:     0
              Num Sounds:     0
      Num Linked Objects:     0
      Num Constant Lists:     0

Obj  1- Collectable Item Object, Saves
        Drawing Priority:    30
         Extra Variables:     0
      Out Of Range Event: _Range_Freeze
                   Flags:     S
       Movement Function: _OMove_Animate
 Scrpt Movement Function: _Func_None
        Drawing Function: _ODraw_Animated
 Script Drawing Function: _Func_None
        Collide Function: _OCol_Item
 Script Collide Function: _Func_None
       PCollide Function: _OPCol_None
 Scrpt PCollide Function: _Func_None
        Debug P Function: _ODebugP_Standard
 Script Debug P Function: _Func_None
        Debug D Function: _ODebugD_FirstFrame
 Script Debug D Function: _Func_None
 Spawn Values-      None
         Num Sprite Sets:     1
 Sprite 0-        Set ID:    G1 ;Game Sprite Set 1
          Num Animations:     1
 Ani 0-     Animation ID:    G0 ;Game Animation 0
              Num Sounds:     1
 Sound 0-       Sound ID:    G4 ;Game Sound Effect 4 (plays when the item is picked up
      Num Linked Objects:     1
 Object 0-     Object ID:    G2 ;Game Object 2 (spawns when the item is picked up)
      Num Constant Lists:     1
 List 0-   Num Constants:     3
              Constant 0:    a8 ;User-created "Active Variable" 8
              Constant 1:     1 ;Item increases variable by 1
              Constant 2:   999 ;Variable should not excede 999

Obj  2- Path-Mobile Script-Driven Object That Has Custom Collision With the Player, Spawned By Another Object, Not By "Debug", Doesn't Save
        Drawing Priority:    30
         Extra Variables:    14
      Out Of Range Event: _Range_Freeze
                   Flags:     0
       Movement Function: _OMove_Floor_Normal
 Scrpt Movement Function:    G0 ;Game Scripted Object Movement Function 0
        Drawing Function: _ODraw_Animated_Directional
 Script Drawing Function: _Func_None
        Collide Function: _OCol_None
 Script Collide Function:    G0 ;Game Scripted Object Collision Function 0
       PCollide Function: _OPCol_None
 Scrpt PCollide Function: _Func_None
        Debug P Function: _ODebugP_None
 Script Debug P Function: _Func_None
        Debug D Function: _ODebugD_None
 Script Debug D Function: _Func_None
 Spawn Values-   Value 0:    *0 -Reserved 1     ;Obtain initial value from spawn parameter 0
                 Value 1:    *1 -Reserved 2     ;Obtain initial value from spawn parameter 1
                 Value 2:     0 -XVel
                 Value 3:     0 -YVel
                 Value 4:     0 -XCount
                 Value 5:     0 -YCount
                 Value 6:     0 -XAccel
                 Value 7:     0 -YAccel
                 Value 8:   R12 -Layer		;Obtain initial value from User Register 12 when spawned
                 Value 9:     0 -EdgePause
                Value 10:     4 -SlopeTolerance
                Value 11:     8 -DropTolerance
                Value 12:     8 -RiseTolerance
         Num Sprite Sets:     1
 Sprite 0-        Set ID:    G2 ;Game Sprite Set 2
          Num Animations:     2
 Ani 0-     Animation ID:    G1 ;Game Animation 1
 Ani 1-     Animation ID:    G1 ;Game Animation 2
              Num Sounds:     0
      Num Linked Objects:     0
      Num Constant Lists:     0

Obj  3- Vertical PlaneSwitch Left to Plane 2, Right to Plane 3, Player must be on path for change to take effect, Saves
        Drawing Priority:    30
         Extra Variables:     0
      Out Of Range Event: _Range_Freeze
                   Flags:     S
       Movement Function: _OMove_None
 Scrpt Movement Function: _Func_None
        Drawing Function: _ODraw_PlaneSwitchV
 Script Drawing Function: _Func_None
        Collide Function: _OCol_PlaneSwitchV
 Script Collide Function: _Func_None
       PCollide Function: _OPCol_None
 Scrpt PCollide Function: _Func_None
        Debug P Function: _ODebugP_Standard
 Script Debug P Function: _Func_None
        Debug D Function: _ODebugD_PlaneSwitchV
 Script Debug D Function: _Func_None
 Spawn Values-      None
         Num Sprite Sets:     1
 Sprite 0-        Set ID:    G1 ;Game Sprites Set 1
          Num Animations:     0
              Num Sounds:     0
      Num Linked Objects:     0
      Num Constant Lists:     1
 List 0-   Num Constants:     3
              Constant 0:     3 ;Plane ID ->
              Constant 1:     2 ;Plane ID <-
              Constant 2:     0 ;Must be on path

Obj  4- 4x4 Tiled Path Object That Moves Through Freespace (No Level Collision), Doesn't Save, Destroyed When out of "Activity Range"
        Drawing Priority:    90
         Extra Variables:    15
      Out Of Range Event: _Range_Destroy
                   Flags:     0
       Movement Function: _OMove_Normal
 Scrpt Movement Function: _Func_None
        Drawing Function: _ODraw_Tiled
 Script Drawing Function: _Func_None
        Collide Function: _OCol_Tiled
 Script Collide Function: _Func_None
       PCollide Function: _OPCol_None
 Scrpt PCollide Function: _Func_None
        Debug P Function: _ODebugP_Standard
 Script Debug P Function: _Func_None
        Debug D Function: _ODebugD_Tiled
 Script Debug D Function: _Func_None
 Spawn Values-   Value 0:     8 -Plat Start      ;Tile Map Data starts at "Extra Variable" 8
                 Value 1:     0 -Reserved 2
                 Value 2:     0 -X Vel           ;"Extra Variables" 2-7 are being used by standard freespace movement
                 Value 3:     0 -Y Vel
                 Value 4:     0 -X Count
                 Value 5:     0 -Y Count
                 Value 6:     0 -X Accel
                 Value 7:   $32 -Y Accel
                   Width:     2 -Width           ;Tile Map Data, begins with Height, Width, and Plane ID properties, then Map Layout Data
                  Height:     2 -Height
                   Plane:     0 -Plane
              TileID   0:    12 -Tile ID  0, 0
              TileID   1:    13 -Tile ID  1, 0
              TileID   2:    14 -Tile ID  0, 1
              TileID   3:    15 -Tile ID  1, 1
         Num Sprite Sets:     0
          Num Animations:     0
              Num Sounds:     0
      Num Linked Objects:     0
      Num Constant Lists:     0